Skip to content

Fix the link in rustdoc.md #143438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2025
Merged

Fix the link in rustdoc.md #143438

merged 1 commit into from
Jul 7, 2025

Conversation

makai410
Copy link
Contributor

@makai410 makai410 commented Jul 4, 2025

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Jul 4, 2025

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 4, 2025
@ehuss
Copy link
Contributor

ehuss commented Jul 4, 2025

Thanks! However, I don't think the new link is correct. This file is rendered at https://doc.rust-lang.org/nightly/rustdoc.html, and it is trying to link to the Rust Book. However, it is currently going to the older link at https://doc.rust-lang.org/nightly/book/documentation.html.

I think this would either link to book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments or rustdoc/index.html.

@GuillaumeGomez do you have a preference?

@GuillaumeGomez
Copy link
Member

If we're talking about working on rustdoc, I'd link to https://rustc-dev-guide.rust-lang.org/rustdoc-internals.html. If it's about using rustdoc, I'd link to https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html.

@ehuss
Copy link
Contributor

ehuss commented Jul 4, 2025

Yea, this is for users. You can see what the old docs looked like at https://doc.rust-lang.org/0.11.0/rustdoc.html.

@rust-log-analyzer

This comment has been minimized.

@ehuss
Copy link
Contributor

ehuss commented Jul 7, 2025

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jul 7, 2025

📌 Commit be9669f has been approved by ehuss

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 7, 2025
bors added a commit that referenced this pull request Jul 7, 2025
Rollup of 9 pull requests

Successful merges:

 - #132469 (Do not suggest borrow that is already there in fully-qualified call)
 - #143340 (awhile -> a while where appropriate)
 - #143438 (Fix the link in `rustdoc.md`)
 - #143539 (Regression tests for repr ICEs)
 - #143566 (Fix `x86_64-unknown-netbsd` platform support page)
 - #143572 (Remove unused allow attrs)
 - #143583 (`loop_match`: fix 'no terminator on block')
 - #143584 (make `Machine::load_mir` infallible)
 - #143591 (Fix missing words in future tracking issue)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 1b922d3 into rust-lang:master Jul 7, 2025
11 checks passed
@rustbot rustbot added this to the 1.90.0 milestone Jul 7, 2025
rust-timer added a commit that referenced this pull request Jul 7, 2025
Rollup merge of #143438 - makai410:rustdoc-fix, r=ehuss

Fix the link in `rustdoc.md`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants